图形化显示 Python 函数之间的调用关系

0X00 前言

由于最近在分析 Python 写成的项目的代码，但是由于项目庞大、设计函数繁多、调用关系复杂，往往单纯地依靠肉眼和注释等方式去记录或者是使用 Pycharm 等编译工具去动态的调试在我看来都不能满足我对整个项目运行过程清楚理解的需要，因此就需要一款工具能比较方便的记录程序运行过程中的函数调用关系，最好还能使用图形化的形式表示出来，就非常类似于 IDA 的函数流程框图的功能，我找了一下还真有这样的好用的东西，于是这里简单的记录一下，方便后面的使用。

0X01 安装方法

1.下载并安装graphviz

下载地址：https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi

注意：安装路径可任意选择

2.配置环境变量

比如我的安装路径是

E:\Graphviz2.38

那么就在系统环境变量 path 中添加下面的项

E:\Graphviz2.38\bin

3.安装 pycallgraph

pip install pycallgraph

0X02 使用方法

1.在项目主函数所在文件中引入依赖包

比如如果我分析的是 sqlmap ，那么我们可以在 sqlmap.py 中添加下面的依赖

from pycallgraph import PyCallGraph
from pycallgraph.output import GraphvizOutput
from pycallgraph import Config
from pycallgraph import GlobbingFilter

如下图所示：

注意：

这里有一个点就是有些项目可能会规定某些 import
必须在第一行，那么如果这时候你把这个引用放在最上面可能项目不能正常运行，这要根据不同的项目而定

2.设定要显示或者不要显示的函数

我们在 if __name__ == "__main__": 下，main() 之上可设置我们想要在图中显示的函数和想要隐藏的函数(这个设置不是必须的，在我的使用中就没有特殊的需要，我便没有设置)

def main():
    # 你的主函数代码。

if __name__ == "__main__":
    # 下面是添加部分
    config = Config()
    # 关系图中包括(include)哪些函数名。
    #如果是某一类的函数，例如类gobang，则可以直接写'gobang.*'，表示以gobang.开头的所有函数。（利用正则表达式）。
    config.trace_filter = GlobbingFilter(include=[
        'main',
        'draw_chessboard',
        'draw_chessman',
        'draw_chessboard_with_chessman',
        'choose_save',
        'choose_turn',
        'choose_mode',
        'choose_button',
        'save_chess',
        'load_chess',
        'play_chess',
        'pop_window',
        'tip',
        'get_score',
        'max_score',
        'win',
        'key_control'
    ])
    # 该段作用是关系图中不包括(exclude)哪些函数。(正则表达式规则)
    # config.trace_filter = GlobbingFilter(exclude=[
    #     'pycallgraph.*',
    #     '*.secret_function',
    #     'FileFinder.*',
    #     'ModuleLockManager.*',
    #     'SourceFilLoader.*'
    # ])
    ...

3.main()前调用我们的绘图函数

...
graphviz = GraphvizOutput()
graphviz.output_file = 'graph.png'
with PyCallGraph(output=graphviz, config=config):
    main()

如图所示：

注意：

因为我这里没有特别的配置于是 PyCallGraph() 函数里没有上面代码中的 config 选项

0X03 运行结果

1.运行我的 sqlmap.py

2.在当前目录下生成指定图片

3.图片效果

0X04 总结

现在可以愉快地开始我们的分析之旅了！

0X05 参考

https://blog.csdn.net/qq_36408085/article/details/82952846
https://blog.csdn.net/Marksinoberg/article/details/52809192